Rainbow Android SDK/com.ale.rainbowsdk/Telephony

Telephony

interface Telephony

Types

Link copied to clipboard
object Companion
Link copied to clipboard
enum PbxType : Enum<Telephony.PbxType>

Properties

Link copied to clipboard
abstract val callSessionsToDisplay: ISessionsToDisplay

Get an ISessionsToDisplay containing all PBX call that needs to be displayed

Link copied to clipboard
abstract val pbxType: Telephony.PbxType

Get the PbxType. Only available for Hybrid PBX.

Link copied to clipboard
abstract val sessionsToDisplay: Array<ISession>

Get an array containing all PBX call that needs to be displayed

Functions

Link copied to clipboard
abstract fun abortMakeCall()

Abort the last make call request

Link copied to clipboard
abstract fun alternate(activeSession: ISession?, heldSession: ISession?)

Alternate between the two PBX calls provided in parameter

Link copied to clipboard
abstract fun areVoipCallsIgnoredOnDnd(): Boolean

Let you know if the parameter to ignore pbx calls in DND is set.

Link copied to clipboard
abstract fun blindTransferTo(callId: String?, phoneNumberValue: String?)

Blind transfer the current call to a specified number. Only available for Cloud PBX.

abstract fun blindTransferTo(callId: String?, webRTCCall: WebRTCCall?, listener: RainbowListener<Unit, BlindTransferError>?)

Blind transfer the current call to a P2P WebRTCCall. Only available for Cloud PBX.

Link copied to clipboard
abstract fun clearCall(session: ISession?)

Terminate the PBX call provided in parameter

Link copied to clipboard
abstract fun conference(activeSession: ISession?, heldSession: ISession?)

Conference between the two PBX calls provided in parameter

Link copied to clipboard
abstract fun deflectCallTo(session: ISession?, number: String?)

Deflect the incoming PBX call provided in parameter to the number also provided in parameter

Link copied to clipboard
abstract fun deflectCallToVoicemail(session: ISession?)

Deflect the incoming PBX call provided in parameter to the voicemail is the user has one

Link copied to clipboard
abstract fun getCurrentCallingNumber(): String?

Get the current calling phone number

Link copied to clipboard
abstract fun hideIncomingCalls()

Since you can not reject an incoming PBX call, you can ask to hide them. They will continue to ring at PBX side but will be no more visible in the application.

Link copied to clipboard
abstract fun hold(session: ISession?)

Hold the PBX call provided in parameter

Link copied to clipboard
abstract fun isStartingMakeCall(): Boolean

Let you know if telephony is currently starting an outgoing call

Link copied to clipboard
abstract fun isThereAVoIPPbxCall(): Boolean

Let you know if there is any VoIP PBX call

Link copied to clipboard
abstract fun makeCall(phoneNumber: PhoneNumber?, correlatorData: String?, listener: IMakeCallListener?)

Perform a PBX call to the provided number

Link copied to clipboard
abstract fun pickUp(legId: String, callId: String, listener: RainbowListener<Unit, Unit>?)

Let you pickup a supervised call. Only for Hybrid users.

Link copied to clipboard
abstract fun retrieve(session: ISession?)

Retrieve the PBX call provided in parameter

Link copied to clipboard
abstract fun sendDTMF(dtmf: String, callId: String?)

Send a DTMF to the current ongoing call (VoIP calls only)

Link copied to clipboard
abstract fun takeCall(session: ISession?)

Take the PBX call provided in parameter

Link copied to clipboard
abstract fun transfer(session: ISession?, heldSession: ISession?)

Transfer the first PBX call provided in parameter to the second call also provided in parameter

Link copied to clipboard
abstract fun transferTo(session: ISession, phoneNumber: PhoneNumber)

Transfer the current call to a specified number. Only available for Hybrid PBX.